Public Class JsonGetterConverter As AbstractJsonFunctionConverter

Code Sample

• %REM
  The following code is an abbreviated version of code in CustomGetterTest. Custom Getters are used in serialization - conversion to JSON. This code calls a getName(order as Boolean) function, writing the result to the "name" label in the resulting JSON object.
  %END REM
  Dim helper as New JsonConversionHelper()
  Dim nameGetter as New JsonGetterConverter()
  Dim jsonObj as JsonObject
  
  Call nameGetter.forGetter("getName").withLiteralParam(true)
  Set jsonObj = helper.withCustomConverter("name, nameGetter)

Methods Detail

• forGetter

  Public Function forGetter(getterName As String) As JsonGetterConverter
  Passes the getter name to look for in the relevant class
  idx	Argument	Data Type	Attributes	Comments
  1	getterName	String		Function in the target class
  Code Sample
  %REM The following code is an abbreviated version of code in CustomGetterTest. Custom Getters are used in serialization - conversion to JSON. This code calls a getName(order as Boolean) function, writing the result to the "name" label in the resulting JSON object. %END REM Dim person as New Person("John", "Doe", 42) Dim helper as New JsonConversionHelper() Dim nameGetter as New JsonGetterConverter() Dim jsonObj as JsonObject Call nameGetter.forGetter("getName").withLiteralParam(true) Set jsonObj = helper.withCustomConverter("name", nameGetter).toJson(person)

• deserialize

  Public Sub deserialize(holder As JsonConversionHolder, source As JsonObject)
  Overridden function, throws error for that class - getters are only for serialization.
  idx	Argument	Data Type	Attributes	Comments
  1	holder	JsonConversionHolder		Object to deserialize to
  2	source	JsonObject		JSON object to deserialize from
  Throws Exceptions
  Message	Error Code	Comments
  JsonGetterConverters can only be used for serialization	1400

• New

  Public Sub New()

• serialize

  Public Sub serialize(source As Variant, target As JsonObject)
  Overridden function
  idx	Argument	Data Type	Attributes	Comments
  1	source	Variant		VoltScript object from which to serialize
  2	target	JsonObject		JsonObject to write to
  Code Sample
  %REM Converters are required for every property to be serialized to JSON, because we cannot use reflection to know what properties exist. So this code loops through all converters in the JsonConversionHelper and call their serialize method, which populates the JSON object from the global SamsaraObj, which has already been populated with a VoltScript object (e.g. an instance of a Person class). The code is an abbreviated version of code in JsonConversionHelper.processObjectToJson() %END REM Dim returnObj as New JsonObject() ForAll converters in Me.converters Call converter.serialize(samsaraObj, returnObj) End ForAll